Summary

Fully Qualified Name:	Laminas\Filter\Compress
Extends:	AbstractFilter

Description

Methods

Name	Description	Defined By
__call()	Calls adapter methods	Compress
__construct()	Class constructor	Compress
__invoke()	Invoke filter as a command	AbstractFilter
filter()	Defined by Laminas\Filter\FilterInterface	Compress
getAdapter()	Returns the current adapter, instantiating it if necessary	Compress
getAdapterName()	Retrieve adapter name	Compress
getAdapterOptions()	Retrieve adapter options	Compress
getOptions()	Get individual or all options from underlying adapter	Compress
hasPcreUnicodeSupport()		AbstractFilter
setAdapter()	Sets compression adapter	Compress
setAdapterOptions()	Set adapter options	Compress
setOptions()	Set filter setate	Compress

Method Details

__call()

Calls adapter methods

Parameter Name	Type	Description
$method	string	Method
$options	string|array	Options

Returns: mixed

__construct()

Class constructor

Parameter Name	Type	Description
$options	string|array|\Traversable	(Optional)

Returns:

__invoke()

Invoke filter as a command

Proxies to {@link filter()}

Parameter Name	Type	Description
$value	mixed

Returns: mixed

filter()

Defined by Laminas\Filter\FilterInterface

Compresses the content $value with the defined settings

Parameter Name	Type	Description
$value	string	Content

Returns: string The compressed content

getAdapter()

Returns the current adapter, instantiating it if necessary

Returns: \Compress\CompressionAlgorithmInterface

getAdapterName()

Retrieve adapter name

Returns: string

getAdapterOptions()

Retrieve adapter options

Returns: array

getOptions()

Get individual or all options from underlying adapter

Parameter Name	Type	Description
$option	null|string

Returns: mixed

hasPcreUnicodeSupport()

Returns: bool

setAdapter()

Sets compression adapter

Parameter Name	Type	Description
$adapter	string|\Compress\CompressionAlgorithmInterface	Adapter

Returns: self

setAdapterOptions()

Set adapter options

Parameter Name	Type	Description
$options	array

Returns: self

setOptions()

Set filter setate

Parameter Name	Type	Description
$options	array

Returns: self